home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iComms.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  3KB  |  152 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iComms.h
  5. //
  6. // Package API for I-War 2 comms management
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /iwar2/packages/iComms.h 10    2/04/01 14:15 Derekm $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(iComms);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "icomms" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24.  
  25. #else
  26.  
  27.  
  28. //
  29. // iComms.IsInConversation
  30. //
  31. // Return TRUE if there is a conversation going on, or waiting 
  32. // for the phrase to be printed.
  33. //
  34. prototype bool iComms.IsInConversation();
  35.  
  36. //
  37. // iComms.IsBusy
  38. //
  39. // Return TRUE if the player is listening to a conversation phrase or 
  40. // choosing a response.
  41. //
  42. prototype bool iComms.IsBusy();
  43.  
  44. //
  45. // iComms.Shout
  46. //
  47. // Shout a message to the player, which will only be heard if no other
  48. // phrase is currently in progress.
  49. //
  50. prototype iComms.Shout( hobject speaker, string speaker_key, string phrase_key );
  51.  
  52. //
  53. // bool iComms.BeginConversation
  54. //
  55. // Begin a conversation with the given speaker. This function will not 
  56. // begin a conversation unless the conversation lock is free.
  57. //
  58. prototype bool iComms.BeginConversation();
  59.  
  60. //
  61. // iComms.EndConversation
  62. //
  63. // End the current conversation and release the conversation lock.
  64. //
  65. prototype iComms.EndConversation();
  66.  
  67. //
  68. // iComms.ClearResponses
  69. //
  70. // Clear the current set of responses.
  71. //
  72. prototype iComms.ClearResponses();
  73.  
  74. //
  75. // iComms.AddResponse
  76. //
  77. // Add a conversation response to the list. 
  78. //
  79. prototype iComms.AddResponse( string menu_key, string phrase_key );
  80.  
  81. //
  82. // iComms.AddResponseWithCode
  83. //
  84. // Add a conversation response to the list, specifying a particular code.
  85. //
  86. prototype iComms.AddResponseWithCode( string menu_key, string phrase_key, int code );
  87.  
  88. //
  89. // iComms.Say
  90. //
  91. // Say a conversation phrase.
  92. //
  93. prototype iComms.Say( hobject speaker, string speaker_key, string phrase_key );
  94.  
  95. //
  96. // iComms.CanEnd
  97. //
  98. // Can the conversation be ended safely. The conversation can be ended
  99. // if there's nothing being said that can't be interrupted. This function
  100. // is especially important after questions have been asked, where a response
  101. // is being displayed that the script doesn't know about
  102. //
  103. prototype bool iComms.CanEnd();
  104.  
  105. //
  106. // iComms.Abort
  107. //
  108. // Stops any current conversation immediately. If start_new_conversation
  109. // is set to true, a new conversation will be started. This has the benefit
  110. // of locking out any new conversations.
  111. //
  112. prototype iComms.Abort(bool start_new_conversation);
  113.  
  114. //
  115. // iComms.AbortEnd
  116. //
  117. // Reenable the conversation after an abort
  118. //
  119. prototype iComms.AbortEnd();
  120.  
  121. //
  122. // iComms.IsSaying
  123. //
  124. // Test if the phrase is waiting to be said
  125. //
  126. prototype bool iComms.IsSaying( hobject speaker, string speaker_key, string phrase_key );
  127.  
  128. //
  129. // iComms.Ask
  130. //
  131. // Ask a conversation question. When the question is finished the player
  132. // will be able to select a response. 
  133. //
  134. prototype iComms.Ask( hobject speaker, string speaker_key, string phrase_key );
  135.  
  136. //
  137. // iComms.Response
  138. //
  139. // Returns the player's response, or zero if no response has been chosen
  140. // yet.
  141. //
  142. prototype int iComms.Response();
  143.  
  144. //
  145. // bool iComms.IsOwner()
  146. //
  147. // Does the current task own the conversation?
  148. //
  149. prototype bool iComms.IsOwner();
  150.  
  151. #endif // FLUX_LIB
  152.